Skip to main content
Version: 3.8

APIs

APIs module allows the user to add the naming, description and API type are specified, like-SOAP REST and GraphQL for effective management and communication of your APIs. The APIs screen displays all APIs, regardless of whether they are in draft, approved, or other states.

APIs_screennew

info

The REST, SOAP and GraphQL APIs are separated and shown in their own tabs, while all APIs are listed under the All tab.

Search an API​

The Search tool on the API list pages allows the user to search for an API.

searchapi

  1. Click the Search icon.

The pop up appears as shown below.

searchapi1

  1. Enter the Key word.
tip

Search results shows matches from the following API components:

  • API Name
  • Overview of all components.
  • Resource Name
  • Resource Description.
  • Resource Specification (Swagger or WSDL File Name)
  • API Backend Names
  • Version Names
  • Version Notes
  • API Endpoint Details
  1. Click Search.

The Search results appears as shown below.

searchapi2

Sort API Name​

The sort capability allows you to arrange API names in a certain order based on predefined criteria.

  1. Click on the API Name to apply sort ascending.

sortascending

On applying sort ascending, the upward arrow will be highlighted.

  1. Click on the API Name again to sort descending.

sortdescending

On applying sort descending, the downward arrow will be highlighted.

  1. Click on the API Name again to cancel sorting.

cancelsorting

Canceling sort disables both the upward and downward arrows.

cancelsorting1

Filter by API State​

The Filters allow users to restrict or limit the displayed data based on API State, which helps in focusing on the relevant data.

  1. Click the Filter icon available next to the API State.

filterapi

The drop down appears as shown below.

filterapi1

  1. Enable the checkboxes next to the filter options to select them.

  2. Click OK.

On proceeding, the results are displayed with the highlighted filter icon, shown below.

filterapi2

  1. To reset the filter, click the Filter icon, then select the Reset button, and click OK to confirm.

filterapi3

Export all approved and published APIs​

The Export function allows users to download all approved and published APIs for purposes such as backup, migration, etc.

exportallapis

  1. Click the Cogwheel icon.

The drop down appears as shown below.

exportallapis1

  1. Click Export to download all the available APIs in zip format.

Import all approved or published APIs​

The Import functionality enables users to upload APIs, making it easier to migrate APIs between environments, restore backups, etc.

exportallapis

  1. Click the Cogwheel icon.

The drop down appears as shown below.

importallapis

  1. Click Import.

The Import API Details dialog box appears as shown below.

info

There are two methods for importing Approved and Published APIs:

  • Full Import - The existing artifacts will be removed from this deployment and the artifacts in the imported file shall be populated. SSL certificates, if any, must be manually configured.

  • Delta Import - If the artifact being imported already exists in this instance, it will be updated with the information from the imported file. Artifacts present in this instance but not in the imported file will be left untouched. If the artifact being imported does not exist in this instance, it will be created. SSL certificates, if any, must be configured manually.

  1. Select the Import method as either Full Import or Delta Import as per the requirement.

  2. Click to Upload the backup file from your local disk.

  1. Click Import to import the file.